/*
 * Copyright (c)  2008 Sebastien Tremblay
 *
 * id3-tag-builder - classes.id3.Id3Proxy.java
 *
 * All source and documentation is copyrighted by Sebastien Tremblay
 * (seb at ryders dot net) and made available under the Apache License 2.0.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * $Id: Id3Proxy.java 30 2010-01-08 04:01:06Z ryders $
 */
package com.empireone.id3tagbuilder.classes.id3;

import java.io.File;

/**
 * The <code>Id3Proxy<code> interface defines methods exposed by a ID3 Tag
 * Library in order to be interfaced by id3-tag-builder.
 *
 * The idea behind using a proxy for id3 tagging is to enable the usage of
 * different libraries in different context. eg. library A might be much faster,
 * but not support id3v2.4, whereas library B might support it while being less
 * efficient. The choice of which library to use is then pushed back onto
 * the user.
 *
 * @author Sebastien Tremblay
 */

public interface Id3Proxy {

    /**
     *
     */
    public enum ID3Version {

	/**
	 *
	 */
	V1,
	/**
	 *
	 */
	V2,
	/**
	 *
	 */
	ALL
    }

    /**
     *
     * @param file
     * @param v
     * @throws Id3ProxyException
     */
    public void init(File file, ID3Version v) throws Id3ProxyException;

    /**
     *
     * @return
     */
    public String getLibName();
    /**
     *
     * @return
     */
    public String[] getSupportedExt();

    /**
     *
     */
    public void cleanAllTags();

    //v1.0+
    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setArtist(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setAlbum(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setTitle(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setTrackNo(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setYear(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setGenre(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setComment(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    //v2.0+
    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setAlbumArtist(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setComposer(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setGrouping(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setDiscNo(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setCoverArt(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     * this is a test...
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setBPM(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setIsCompilation(boolean value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setEncoder(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setPublisher(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setOrigArtist(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setCopyright(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @param value
     * @throws Id3ProxyDataException
     * @throws Id3ProxyUnsupportedException
     */
    public void setURL(String value) throws Id3ProxyDataException, Id3ProxyUnsupportedException;

    /**
     *
     * @throws Id3ProxyException
     */
    public void save() throws Id3ProxyException;
}
